<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template metadata_base</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Histogram">
<link rel="up" href="../../../histogram/reference.html#header.boost.histogram.axis.metadata_base_hpp" title="Header &lt;boost/histogram/axis/metadata_base.hpp&gt;">
<link rel="prev" href="iterator_mixin.html" title="Class template iterator_mixin">
<link rel="next" href="option/bit.html" title="Struct template bit">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="iterator_mixin.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.metadata_base_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="option/bit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.histogram.axis.metadata_base"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template metadata_base</span></h2>
<p>boost::histogram::axis::metadata_base — Meta data holder with space optimization for empty meta data types. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../histogram/reference.html#header.boost.histogram.axis.metadata_base_hpp" title="Header &lt;boost/histogram/axis/metadata_base.hpp&gt;">boost/histogram/axis/metadata_base.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Metadata<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="metadata_base.html#boost.histogram.axis.metadata_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="metadata_base.html#idm14554-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  <a class="link" href="metadata_base.html#idm14555-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  <a class="link" href="metadata_base.html#idm14565-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <a class="link" href="metadata_base.html#idm14569-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><span class="identifier">metadata_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm14559-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm14572-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="metadata_base.html#idm14578-bb">public member functions</a></span>
  <span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm14579-bb"><span class="identifier">metadata</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm14582-bb"><span class="identifier">metadata</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm26138"></a><h2>Description</h2>
<p>Allows write-access to metadata even if const.</p>
<p>
</p>
<div class="refsect2">
<a name="idm26142"></a><h3>Template Parameters</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">typename</span> Metadata</pre>
<p>Wrapped meta data type. </p>
</li></ol></div>
</div>
<div class="refsect2">
<a name="idm26151"></a><h3>
<a name="boost.histogram.axis.metadata_baseconstruct-copy-destruct"></a><code class="computeroutput">metadata_base</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="idm14554-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="idm14555-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="idm14565-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="idm14569-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><span class="identifier">metadata_type</span> <span class="special">&amp;&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a name="idm14559-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a name="idm14572-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="idm26231"></a><h3>
<a name="idm14578-bb"></a><code class="computeroutput">metadata_base</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a name="idm14579-bb"></a><span class="identifier">metadata</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns reference to metadata. </li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a name="idm14582-bb"></a><span class="identifier">metadata</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns reference to mutable metadata from const axis. </li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
      Dembinski<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="iterator_mixin.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.metadata_base_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="option/bit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
